home *** CD-ROM | disk | FTP | other *** search
/ TeX 1995 July / TeX CD-ROM July 1995 (Disc 1)(Walnut Creek)(1995).ISO / web / fweb / fweb-1.30 / READ_ME.FWEB < prev    next >
Text File  |  1993-06-16  |  6KB  |  154 lines
  1.                --- FWEB v. 1.30 ---
  2.                    June 15, 1993
  3.  
  4.  
  5. IMPORTANT NOTES:
  6.  
  7. * THE INSTALLATION PROCEDURE HAS CHANGED FOR UNIX USERS.  I am attempting
  8. to gravitate toward the GNU standards for configuration, makefiles, etc.
  9. If you are a Unix user (more precisely, if you have sh available), please
  10. follow the modified procedure described below under item (0) of ``SUMMARY
  11. of INSTALLATION PROCEDURE''.
  12.  
  13. * There is now a separate make file for the user manual:  manual/Makefile.
  14. To obtain a short reference guide to FWEB, you must first run ./configure
  15. (see below).  Then say 
  16.  
  17.     cd manual
  18.     make guide
  19.  
  20. To obtain the complete (LONG!) user manual (which incorporates the
  21. reference guide as several appendices), say
  22.     
  23.     cd manual
  24.     make manual
  25.  
  26. * The indexes for the user manual and reference guide require the utility
  27. routine makeindex.  This can be obtained by anonymous ftp from
  28.  
  29.     ftp.math.utah.edu:/pub/tex/pub/makeindex/2-11
  30.  
  31. (The extension .trz is equivalent to .tar.Z.)
  32.  
  33.  
  34. SUMMARY of INSTALLATION PROCEDURE:
  35.  
  36.   (0) If you are a Unix user, especially one with an ANSI-C compiler
  37. (please use gcc), please try to install FWEB by doing the following: 
  38.  
  39. ------------------------------------------------------------------------------
  40.     cd fweb-1.30
  41.     ./configure 
  42.     cd web
  43.     make bootstrap
  44.     make -n install
  45. (Use the -n option to see where various files are going to be put.  If you
  46. need to make changes, make them in defaults.mk.in, then rerun ./configure.)
  47.     [Log on as root]
  48.     make install
  49. -------------------------------------------------------------------------------
  50.  
  51. ./configure is a sh script that was generated automatically by running the
  52. utility program autoconf.  It first reads an FWEB configuration file whose
  53. default name is configure.ini.  (More about that below.)  Then it
  54. attempts to figure out various local system features automatically.
  55. Finally, it generates two files from autoconf templates:
  56.  
  57.     ./web/defaults.mk.in  => ./web/defaults.mk
  58.     ./web/custom.h.in => ./web/custom.h
  59.  
  60. The file defaults.mk is included into both ./web/Makefile and
  61. ./manual/Makefile.  The file custom.h is included into the C code by the
  62. ./web/*.c files.  Check out what configure does, especially for the
  63. directory prefixes in the INSTALLATION section of defaults.mk.  If you need
  64. to make changes, make them in the *.in files, then run ./configure again.
  65.  
  66.   For more information about automatic configuration, read the file
  67. UNIX_INSTALL.  
  68.  
  69.   If you are compiling on a Sun, ignore warnings such as 
  70.  
  71.     ``implicit declaration of function `printf' ''
  72.  
  73. (If you know where such functions are defined---it's usually
  74. stdio.h---please let me know.)
  75.  
  76.   The present procedure differs in one respect from standard ./configure
  77. protocol: an extra layer of variable definitions is used for variables
  78. related to FWEB that are not figured out automatically by ./configure.
  79. E.g., instead of saying in defaults.mk.in ``OBJ = obj'', we say ``OBJ =
  80. @_OBJ_@''.  Configure replaces the @_OBJ_@ with the present value of the
  81. environment variable _OBJ_.  To give that a value, configure sources in the
  82. contents of the file $CONFIGURE_INI.  If the environment variable CONFIGURE_INI
  83. isn't defined, then the default file config.ini is read.  This mechanism is
  84. partly used to aid the developer--files like ansi.ini are used to
  85. automatically generate the old-style bootstrap files---and partly to ease
  86. the transition to ./configure, which doesn't figure everything out for
  87. itself yet.
  88.  
  89.   Note that the old bootstrapping mechanism remains in place for those who
  90. need it.  That consists of the boot subdirectory, containing various
  91. suggested defaults.mk and custom.h files.  Therefore, if configure doesn't
  92. seem to be doing the right thing, please let me know and revert to the old
  93. procedure using the installation script install.fweb.
  94.  
  95.   (1) If you are a Unix user, but ./configure didn't work, use the
  96. installation script install.fweb.
  97.  
  98. Otherwise:
  99.  
  100.   (2) Select a boot subdirectory, for example
  101.  
  102.     boot/unix/ansi/
  103.  
  104. that you think corresponds to your machine.   That directory should contain
  105. a READ_ME file (that you should read!), and in particular the files
  106.  
  107.     custom.h defaults.mk
  108.  
  109. (Even if there's a bootstrap subdirectory that sounds like your machine,
  110. please try to use the ansi bootstrap first.  Some of the bootstraps may be
  111. out of date.  If your compiler is supposed to be ANSI but it doesn't work
  112. with the ansi bootstrap, please (a) notify me; (b) complain to the vendor.)
  113.  
  114.   (3) COPY custom.h to the web subdirectory.  This file contains macro
  115. definitions and file includes that may need to be modified for your
  116. particular compiler and/or operating system.  If the compile and link below
  117. does not work, you may have to edit custom.h, following the instructions in
  118. that file.
  119.  
  120.   (4) COPY defaults.mk to the web directory.  Then examine it
  121. to see if anything needs to be changed there.  This file is included into
  122. web/Makefile; it sets up the compiler and link lines, etc.  For example, you
  123. may want to include a compiler optimization command.  As another example,
  124. Cray users may need to change the name of the compiler from cc to scc.  If your
  125. compiler permits, also use the flag that makes the default |char| type
  126. |unsigned|.
  127.  
  128.   (5) Say
  129.  
  130.     cd web
  131.     make -n bootstrap
  132.  
  133. to see what will happen when you compile and link.  If all seems in order,
  134. then do it without the -n option.
  135.  
  136.   (6) If something doesn't compile properly, you may need to edit custom.h;
  137. follow the instructions in that file.
  138.  
  139.   (7) (Omitted.)
  140.  
  141.   (8) With this old-style bootstrapping procedure, there is no automatic
  142. procedure for installing the files into their final resting place.  Look
  143. into the Makefile for the ``install:'' target to see what should be done.
  144.  
  145.   (9) To obtain brief help about the Makefiles, type
  146.  
  147.     make help
  148.  
  149. To learn more, read the notes at the beginning of Makefile.
  150.  
  151.  
  152.  
  153.  
  154.